vcUnit

Unit represents a single unit of measurement complete with a name, suffix and properties for describing linear mapping between canonical and unit values.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: vcMatrixProperty.Unit, vcMatrixStepProperty.Unit, vcRealExpressionProperty.Unit, vcRealLimitProperty.Unit, ... (see more)

vcMatrixProperty.Unit
vcMatrixStepProperty.Unit
vcRealExpressionProperty.Unit
vcRealLimitProperty.Unit
vcRealProperty.Unit
vcRealStepProperty.Unit
vcUnitGroup.Units
vcUnitGroup.createUnit()
vcUnitGroup.findUnit()
vcUnitGroup.getUnitWithMagnitude()
vcVectorProperty.Unit
vcVectorStepProperty.Unit

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Factor	Real	RW	Gets or sets if unit is built-in, gets conversion factor; otherwise gets or sets conversion factor. That is, the size of unit in canonical units which must be larger than zero.
IsBuiltIn	Boolean	R	Gets if unit is built-in.
Name	String	RW	Gets or sets unit name. See more Exceptions: ValueError: When given name is empty or not unique within the unit group this unit belongs to.
Offset	Real	RW	Gets or sets if unit is built-in, gets zero-point offset; otherwise gets or sets the canonical value at which the unit value is zero.
Suffix	String	RW	Gets or sets unit suffix. See more Exceptions: ValueError: When given suffix is empty or not unique within the unit group this unit belongs to.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
delete	None	None	Deletes the unit. Exceptions: RuntimeError: When deleting from a built-in unit group.